API Documentation
Classes | Public Member Functions | List of all members
nkWinUi::TabWindow Class Referenceabstract

A graphical tab window. More...

Inheritance diagram for nkWinUi::TabWindow:
nkWinUi::Component nkExport::Exportable

Classes

class  Tab
 Holds information about a tab in the window. More...
 

Public Member Functions

 TabWindow ()
 
 ~TabWindow ()
 
virtual TabaddTab (const std::string_view &label)
 
TabgetTabByLabel (const std::string_view &label) const
 
TabgetTabById (int id) const
 
virtual void changeTabLabel (const std::string_view &oldLabel, const std::string_view &newLabel)
 
virtual void eraseTab (const std::string_view &label)
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType) override
 
virtual void setActiveTab (Tab *toActivate)
 
TabgetActiveTab () const
 
virtual void adaptToDisplayArea (Window *toAdapt) const =0
 
void setTabSpecializedCallback (tabWindowCallback value)
 
tabWindowCallback getTabSpecializedCallback () const
 
virtual void exportIntrospection (nkExport::Node *rootNode) override
 
void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkWinUi::Component
 Component ()
 
virtual ~Component ()
 
LayoutgetLayout () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getArea () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
const char * getComponentName () const
 
bool getVisibility () const
 
virtual const char * getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setArea (nkMaths::Rectangle area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const std::string_view &label)
 
void setComponentName (const std::string_view &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
virtual void updateWindow ()
 
nkImages::Image paintToImage ()
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
ContextMenucreateContextMenu ()
 
ContextMenugetCurrentContextMenu ()
 
void shutContextMenu ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical tab window.

Constructor & Destructor Documentation

◆ TabWindow()

nkWinUi::TabWindow::TabWindow ( )

Constructor.

◆ ~TabWindow()

nkWinUi::TabWindow::~TabWindow ( )

Destructor.

Member Function Documentation

◆ addTab()

virtual Tab* nkWinUi::TabWindow::addTab ( const std::string_view &  label)
virtual

Adds a tab to the window.

Parameters
labelThe tab label to insert.
Returns
The newly created tab.
Remarks
The TabWindow owns the Tab memory.

◆ getTabByLabel()

Tab* nkWinUi::TabWindow::getTabByLabel ( const std::string_view &  label) const
Parameters
labelThe label of the tab to retrieve.
Returns
The tab attached to given labl if available, nullptr else.

◆ getTabById()

Tab* nkWinUi::TabWindow::getTabById ( int  id) const
Parameters
idThe id of the tab to retrieve.
Returns
The tab attached to given id if available, nullptr else.

◆ changeTabLabel()

virtual void nkWinUi::TabWindow::changeTabLabel ( const std::string_view &  oldLabel,
const std::string_view &  newLabel 
)
virtual

Changes the label of a tab.

Parameters
oldLabelThe old label to find back the tab to alter.
newLabelThe new label to set to the tab.

◆ eraseTab()

virtual void nkWinUi::TabWindow::eraseTab ( const std::string_view &  label)
virtual

Erases a tab and free its memory.

Parameters
labelThe label of the tab to erase.

◆ setLayout()

virtual Layout* nkWinUi::TabWindow::setLayout ( LAYOUT_TYPE  layoutType)
overridevirtual

Sets the layout to use in the currently active window, associated to the active tab. See Component::setLayout() for details.

Reimplemented from nkWinUi::Component.

◆ setActiveTab()

virtual void nkWinUi::TabWindow::setActiveTab ( Tab toActivate)
virtual

Sets the tab currently active and displayed.

Parameters
toActivateThe tab to active.

◆ getActiveTab()

Tab* nkWinUi::TabWindow::getActiveTab ( ) const
Returns
The active tab.

◆ adaptToDisplayArea()

virtual void nkWinUi::TabWindow::adaptToDisplayArea ( Window toAdapt) const
pure virtual

Adapts a window to fit within the tab window displaying area.

Parameters
toAdaptThe window which size should be adapted.

◆ setTabSpecializedCallback()

void nkWinUi::TabWindow::setTabSpecializedCallback ( tabWindowCallback  value)

Sets the tab switch callback. Will be called over the globally set one in InputSystem.

Parameters
valueThe callback to use.

◆ getTabSpecializedCallback()

tabWindowCallback nkWinUi::TabWindow::getTabSpecializedCallback ( ) const
Returns
Currently set tab switch callback.

◆ exportIntrospection()

virtual void nkWinUi::TabWindow::exportIntrospection ( nkExport::Node rootNode)
overridevirtual

◆ importClassFromTree()

void nkWinUi::TabWindow::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

The documentation for this class was generated from the following file: